home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 November / CPNL0711.ISO / admin / secure / Tor - Privoxy - Vidalia.exe / Tor / Documents / control-spec.txt < prev    next >
Text File  |  2007-08-30  |  62KB  |  1,502 lines
  1. $Id: control-spec.txt 11270 2007-08-24 14:41:15Z nickm $
  2.  
  3.                    TC: A Tor control protocol (Version 1)
  4.  
  5. 0. Scope
  6.  
  7.   This document describes an implementation-specific protocol that is used
  8.   for other programs (such as frontend user-interfaces) to communicate with a
  9.   locally running Tor process.  It is not part of the Tor onion routing
  10.   protocol.
  11.  
  12.   This protocol replaces version 0 of TC, which is now deprecated.  For
  13.   reference, TC is described in "control-spec-v0.txt".  Implementors are
  14.   recommended to avoid using TC directly, but instead to use a library that
  15.   can easily be updated to use the newer protocol.  (Version 0 is used by Tor
  16.   versions 0.1.0.x; the protocol in this document only works with Tor
  17.   versions in the 0.1.1.x series and later.)
  18.  
  19. 1. Protocol outline
  20.  
  21.   TC is a bidirectional message-based protocol.  It assumes an underlying
  22.   stream for communication between a controlling process (the "client"
  23.   or "controller") and a Tor process (or "server").  The stream may be
  24.   implemented via TCP, TLS-over-TCP, a Unix-domain socket, or so on,
  25.   but it must provide reliable in-order delivery.  For security, the
  26.   stream should not be accessible by untrusted parties.
  27.  
  28.   In TC, the client and server send typed messages to each other over the
  29.   underlying stream.  The client sends "commands" and the server sends
  30.   "replies".
  31.  
  32.   By default, all messages from the server are in response to messages from
  33.   the client.  Some client requests, however, will cause the server to send
  34.   messages to the client indefinitely far into the future.  Such
  35.   "asynchronous" replies are marked as such.
  36.  
  37.   Servers respond to messages in the order messages are received.
  38.  
  39. 2. Message format
  40.  
  41. 2.1. Description format
  42.  
  43.   The message formats listed below use ABNF as described in RFC 2234.
  44.   The protocol itself is loosely based on SMTP (see RFC 2821).
  45.  
  46.   We use the following nonterminals from RFC 2822: atom, qcontent
  47.  
  48.   We define the following general-use nonterminals:
  49.  
  50.      String = DQUOTE *qcontent DQUOTE
  51.  
  52.   There are explicitly no limits on line length.  All 8-bit characters are
  53.   permitted unless explicitly disallowed.
  54.  
  55. 2.2. Commands from controller to Tor
  56.  
  57.     Command = Keyword Arguments CRLF / "+" Keyword Arguments CRLF Data
  58.     Keyword = 1*ALPHA
  59.     Arguments = *(SP / VCHAR)
  60.  
  61.   Specific commands and their arguments are described below in section 3.
  62.  
  63. 2.3. Replies from Tor to the controller
  64.  
  65.     Reply = SyncReply / AsyncReply
  66.     SyncReply = *(MidReplyLine / DataReplyLine) EndReplyLine
  67.     AsyncReply = *(MidReplyLine / DataReplyLine) EndReplyLine
  68.  
  69.     MidReplyLine = StatusCode "-" ReplyLine
  70.     DataReplyLine = StatusCode "+" ReplyLine Data
  71.     EndReplyLine = StatusCode SP ReplyLine
  72.     ReplyLine = [ReplyText] CRLF
  73.     ReplyText = XXXX
  74.     StatusCode = 3DIGIT
  75.  
  76.   Specific replies are mentioned below in section 3, and described more fully
  77.   in section 4.
  78.  
  79.   [Compatibility note:  versions of Tor before 0.2.0.3-alpha sometimes
  80.   generate AsyncReplies of the form "*(MidReplyLine / DataReplyLine)".
  81.   This is incorrect, but controllers that need to work with these
  82.   versions of Tor should be prepared to get multi-line AsyncReplies with
  83.   the final line (usually "650 OK") omitted.]
  84.  
  85. 2.4. General-use tokens
  86.  
  87.   ; Identifiers for servers.
  88.   ServerID = Nickname / Fingerprint
  89.  
  90.   Nickname = 1*19 NicknameChar
  91.   NicknameChar = "a"-"z" / "A"-"Z" / "0" - "9"
  92.   Fingerprint = "$" 40*HEXDIG
  93.  
  94.   ; A "=" indicates that the given nickname is canonical; a "~" indicates
  95.   ; that the given nickname is not canonical.
  96.   LongName = Fingerprint [ ( "=" / "~" ) Nickname ]
  97.  
  98.   ; How a controller tells Tor about a particular OR.  There are four
  99.   ; possible formats:
  100.   ;    $Digest -- The router whose identity key hashes to the given digest.
  101.   ;        This is the preferred way to refer to an OR.
  102.   ;    $Digest~Name -- The router whose identity key hashes to the given
  103.   ;        digest, but only if the router has the given nickname.
  104.   ;    $Digest=Name -- The router whose identity key hashes to the given
  105.   ;        digest, but only if the router is Named and has the given
  106.   ;        nickname.
  107.   ;    Name -- The Named router with the given nickname, or, if no such
  108.   ;        router exists, any router whose nickname matches the one given.
  109.   ;        This is not a safe way to refer to routers, since Named status
  110.   ;        could under some circumstances change over time.
  111.   ServerSpec = LongName / Nickname
  112.  
  113.   ; Unique identifiers for streams or circuits.  Currently, Tor only
  114.   ; uses digits, but this may change
  115.   StreamID = 1*16 IDChar
  116.   CircuitID = 1*16 IDChar
  117.   IDChar = ALPHA / DIGIT
  118.  
  119.   Address = ip4-address / ip6-address / hostname   (XXXX Define these)
  120.  
  121.   ; A "Data" section is a sequence of octets concluded by the terminating
  122.   ; sequence CRLF "." CRLF.  The terminating sequence may not appear in the
  123.   ; body of the data.  Leading periods on lines in the data are escaped with
  124.   ; an additional leading period as in RFC 2821 section 4.5.2.
  125.   Data = *DataLine "." CRLF
  126.   DataLine = CRLF / "." 1*LineItem CRLF / NonDotItem *LineItem CRLF
  127.   LineItem = NonCR / 1*CR NonCRLF
  128.   NonDotItem = NonDotCR / 1*CR NonCRLF
  129.  
  130. 3. Commands
  131.  
  132.   All commands and other keywords are case-insensitive.
  133.  
  134. 3.1. SETCONF
  135.  
  136.   Change the value of one or more configuration variables.  The syntax is:
  137.  
  138.     "SETCONF" 1*(SP keyword ["=" String]) CRLF
  139.  
  140.   Tor behaves as though it had just read each of the key-value pairs
  141.   from its configuration file.  Keywords with no corresponding values have
  142.   their configuration values reset to 0 or NULL (use RESETCONF if you want
  143.   to set it back to its default).  SETCONF is all-or-nothing: if there
  144.   is an error in any of the configuration settings, Tor sets none of them.
  145.  
  146.   Tor responds with a "250 configuration values set" reply on success.
  147.   If some of the listed keywords can't be found, Tor replies with a
  148.   "552 Unrecognized option" message. Otherwise, Tor responds with a
  149.   "513 syntax error in configuration values" reply on syntax error, or a
  150.   "553 impossible configuration setting" reply on a semantic error.
  151.  
  152.   When a configuration option takes multiple values, or when multiple
  153.   configuration keys form a context-sensitive group (see GETCONF below), then
  154.   setting _any_ of the options in a SETCONF command is taken to reset all of
  155.   the others.  For example, if two ORBindAddress values are configured, and a
  156.   SETCONF command arrives containing a single ORBindAddress value, the new
  157.   command's value replaces the two old values.
  158.  
  159. 3.2. RESETCONF
  160.  
  161.   Remove all settings for a given configuration option entirely, assign
  162.   its default value (if any), and then assign the String provided.
  163.   Typically the String is left empty, to simply set an option back to
  164.   its default. The syntax is:
  165.  
  166.     "RESETCONF" 1*(SP keyword ["=" String]) CRLF
  167.  
  168.   Otherwise it behaves like SETCONF above.
  169.  
  170. 3.3. GETCONF
  171.  
  172.   Request the value of a configuration variable.  The syntax is:
  173.  
  174.     "GETCONF" 1*(SP keyword) CRLF
  175.  
  176.   If all of the listed keywords exist in the Tor configuration, Tor replies
  177.   with a series of reply lines of the form:
  178.       250 keyword=value
  179.   If any option is set to a 'default' value semantically different from an
  180.   empty string, Tor may reply with a reply line of the form:
  181.       250 keyword
  182.  
  183.   If some of the listed keywords can't be found, Tor replies with a
  184.   "552 unknown configuration keyword" message.
  185.  
  186.   If an option appears multiple times in the configuration, all of its
  187.   key-value pairs are returned in order.
  188.  
  189.   Some options are context-sensitive, and depend on other options with
  190.   different keywords.  These cannot be fetched directly.  Currently there
  191.   is only one such option: clients should use the "HiddenServiceOptions"
  192.   virtual keyword to get all HiddenServiceDir, HiddenServicePort,
  193.   HiddenServiceNodes, and HiddenServiceExcludeNodes option settings.
  194.  
  195. 3.4. SETEVENTS
  196.  
  197.   Request the server to inform the client about interesting events.  The
  198.   syntax is:
  199.  
  200.      "SETEVENTS" [SP "EXTENDED"] *(SP EventCode) CRLF
  201.  
  202.      EventCode = "CIRC" / "STREAM" / "ORCONN" / "BW" / "DEBUG" /
  203.          "INFO" / "NOTICE" / "WARN" / "ERR" / "NEWDESC" / "ADDRMAP" /
  204.          "AUTHDIR_NEWDESCS" / "DESCCHANGED" / "STATUS_GENERAL" /
  205.          "STATUS_CLIENT" / "STATUS_SERVER" / "GUARD" / "NS" / "STREAM_BW"
  206.  
  207.   Any events *not* listed in the SETEVENTS line are turned off; thus, sending
  208.   SETEVENTS with an empty body turns off all event reporting.
  209.  
  210.   The server responds with a "250 OK" reply on success, and a "552
  211.   Unrecognized event" reply if one of the event codes isn't recognized.  (On
  212.   error, the list of active event codes isn't changed.)
  213.  
  214.   If the flag string "EXTENDED" is provided, Tor may provide extra
  215.   information with events for this connection; see 4.1 for more information.
  216.   NOTE: All events on a given connection will be provided in extended format,
  217.   or none.
  218.   NOTE: "EXTENDED" is only supported in Tor 0.1.1.9-alpha or later.
  219.  
  220.   Each event is described in more detail in Section 4.1.
  221.  
  222. 3.5. AUTHENTICATE
  223.  
  224.   Sent from the client to the server.  The syntax is:
  225.      "AUTHENTICATE" [ SP 1*HEXDIG / QuotedString ] CRLF
  226.  
  227.   The server responds with "250 OK" on success or "515 Bad authentication" if
  228.   the authentication cookie is incorrect.  Tor closes the connection on an
  229.   authentication failure.
  230.  
  231.   The format of the 'cookie' is implementation-dependent; see 5.1 below for
  232.   information on how the standard Tor implementation handles it.
  233.  
  234.   Before the client has authenticated, no command other than PROTOCOLINFO,
  235.   AUTHENTICATE, or QUIT is valid.  If the controller sends any other command,
  236.   or sends a malformed command, or sends an unsuccessful AUTHENTICATE
  237.   command, or sends PROTOCOLINFO more than once, Tor sends an error reply and
  238.   closes the connection.
  239.  
  240.   (Versions of Tor before 0.1.2.16 and 0.2.0.4-alpha did not close the
  241.   connection after an authentication failure.)
  242.  
  243. 3.6. SAVECONF
  244.  
  245.   Sent from the client to the server.  The syntax is:
  246.      "SAVECONF" CRLF
  247.  
  248.   Instructs the server to write out its config options into its torrc. Server
  249.   returns "250 OK" if successful, or "551 Unable to write configuration
  250.   to disk" if it can't write the file or some other error occurs.
  251.  
  252. 3.7. SIGNAL
  253.  
  254.   Sent from the client to the server. The syntax is:
  255.  
  256.      "SIGNAL" SP Signal CRLF
  257.  
  258.      Signal = "RELOAD" / "SHUTDOWN" / "DUMP" / "DEBUG" / "HALT" /
  259.               "HUP" / "INT" / "USR1" / "USR2" / "TERM" / "NEWNYM" /
  260.               "CLEARDNSCACHE"
  261.  
  262.   The meaning of the signals are:
  263.  
  264.       RELOAD    -- Reload: reload config items, refetch directory. (like HUP)
  265.       SHUTDOWN  -- Controlled shutdown: if server is an OP, exit immediately.
  266.                    If it's an OR, close listeners and exit after 30 seconds.
  267.                    (like INT)
  268.       DUMP      -- Dump stats: log information about open connections and
  269.                    circuits. (like USR1)
  270.       DEBUG     -- Debug: switch all open logs to loglevel debug. (like USR2)
  271.       HALT      -- Immediate shutdown: clean up and exit now. (like TERM)
  272.       CLEARDNSCACHE -- Forget the client-side cached IPs for all hostnames.
  273.       NEWNYM    -- Switch to clean circuits, so new application requests
  274.                    don't share any circuits with old ones.  Also clears
  275.                    the client-side DNS cache.  (Tor MAY rate-limit its
  276.                    response to this signal.)
  277.  
  278.   The server responds with "250 OK" if the signal is recognized (or simply
  279.   closes the socket if it was asked to close immediately), or "552
  280.   Unrecognized signal" if the signal is unrecognized.
  281.  
  282. 3.8. MAPADDRESS
  283.  
  284.   Sent from the client to the server.  The syntax is:
  285.  
  286.     "MAPADDRESS" 1*(Address "=" Address SP) CRLF
  287.  
  288.   The first address in each pair is an "original" address; the second is a
  289.   "replacement" address.  The client sends this message to the server in
  290.   order to tell it that future SOCKS requests for connections to the original
  291.   address should be replaced with connections to the specified replacement
  292.   address.  If the addresses are well-formed, and the server is able to
  293.   fulfill the request, the server replies with a 250 message:
  294.     250-OldAddress1=NewAddress1
  295.     250 OldAddress2=NewAddress2
  296.  
  297.   containing the source and destination addresses.  If request is
  298.   malformed, the server replies with "512 syntax error in command
  299.   argument".  If the server can't fulfill the request, it replies with
  300.   "451 resource exhausted".
  301.  
  302.   The client may decline to provide a body for the original address, and
  303.   instead send a special null address ("0.0.0.0" for IPv4, "::0" for IPv6, or
  304.   "." for hostname), signifying that the server should choose the original
  305.   address itself, and return that address in the reply.  The server
  306.   should ensure that it returns an element of address space that is unlikely
  307.   to be in actual use.  If there is already an address mapped to the
  308.   destination address, the server may reuse that mapping.
  309.  
  310.   If the original address is already mapped to a different address, the old
  311.   mapping is removed.  If the original address and the destination address
  312.   are the same, the server removes any mapping in place for the original
  313.   address.
  314.  
  315.   Example:
  316.     C: MAPADDRESS 0.0.0.0=tor.eff.org 1.2.3.4=tor.freehaven.net
  317.     S: 250-127.192.10.10=tor.eff.org
  318.     S: 250 1.2.3.4=tor.freehaven.net
  319.  
  320.   {Note: This feature is designed to be used to help Tor-ify applications
  321.   that need to use SOCKS4 or hostname-less SOCKS5.  There are three
  322.   approaches to doing this:
  323.      1. Somehow make them use SOCKS4a or SOCKS5-with-hostnames instead.
  324.      2. Use tor-resolve (or another interface to Tor's resolve-over-SOCKS
  325.         feature) to resolve the hostname remotely.  This doesn't work
  326.         with special addresses like x.onion or x.y.exit.
  327.      3. Use MAPADDRESS to map an IP address to the desired hostname, and then
  328.         arrange to fool the application into thinking that the hostname
  329.         has resolved to that IP.
  330.   This functionality is designed to help implement the 3rd approach.}
  331.  
  332.   Mappings set by the controller last until the Tor process exits:
  333.   they never expire. If the controller wants the mapping to last only
  334.   a certain time, then it must explicitly un-map the address when that
  335.   time has elapsed.
  336.  
  337. 3.9. GETINFO
  338.  
  339.   Sent from the client to the server.  The syntax is as for GETCONF:
  340.     "GETINFO" 1*(SP keyword) CRLF
  341.   one or more NL-terminated strings.  The server replies with an INFOVALUE
  342.   message, or a 551 or 552 error.
  343.  
  344.   Unlike GETCONF, this message is used for data that are not stored in the Tor
  345.   configuration file, and that may be longer than a single line.  On success,
  346.   one ReplyLine is sent for each requested value, followed by a final 250 OK
  347.   ReplyLine.  If a value fits on a single line, the format is:
  348.       250-keyword=value
  349.   If a value must be split over multiple lines, the format is:
  350.       250+keyword=
  351.       value
  352.       .
  353.   Recognized keys and their values include:
  354.  
  355.     "version" -- The version of the server's software, including the name
  356.       of the software. (example: "Tor 0.0.9.4")
  357.  
  358.     "config-file" -- The location of Tor's configuration file ("torrc").
  359.  
  360.     ["exit-policy/prepend" -- The default exit policy lines that Tor will
  361.       *prepend* to the ExitPolicy config option.
  362.      -- Never implemented. Useful?]
  363.  
  364.     "exit-policy/default" -- The default exit policy lines that Tor will
  365.       *append* to the ExitPolicy config option.
  366.  
  367.     "desc/id/<OR identity>" or "desc/name/<OR nickname>" -- the latest
  368.       server descriptor for a given OR, NUL-terminated.
  369.  
  370.     "extra-info/digest/<digest>"  -- the extrainfo document whose digest (in
  371.       hex) is <digest>.  Only available if we're downloading extra-info
  372.       documents.
  373.  
  374.     "ns/id/<OR identity>" or "ns/name/<OR nickname>" -- the latest network
  375.       status info for a given OR.  Network status info is as given in
  376.       dir-spec.txt, and reflects the current beliefs of this Tor about the
  377.       router in question. Like directory clients, controllers MUST
  378.       tolerate unrecognized flags and lines.  The published date and
  379.       descriptor digest are those believed to be best by this Tor,
  380.       not necessarily those for a descriptor that Tor currently has.
  381.       [First implemented in 0.1.2.3-alpha.]
  382.  
  383.     "ns/all" -- Network status info (v2 directory style) for all ORs we
  384.       have an opinion about, joined by newlines. [First implemented
  385.       in 0.1.2.3-alpha.]
  386.  
  387.     "desc/all-recent" -- the latest server descriptor for every router that
  388.       Tor knows about.
  389.  
  390.     "network-status" -- a space-separated list (v1 directory style)
  391.       of all known OR identities. This is in the same format as the
  392.       router-status line in v1 directories; see dir-spec-v1.txt section
  393.       3 for details.  (If VERBOSE_NAMES is enabled, the output will
  394.       not conform to dir-spec-v1.txt; instead, the result will be a
  395.       space-separated list of LongName, each preceded by a "!" if it is
  396.       believed to be not running.)
  397.  
  398.     "address-mappings/all"
  399.     "address-mappings/config"
  400.     "address-mappings/cache"
  401.     "address-mappings/control" -- a \r\n-separated list of address
  402.       mappings, each in the form of "from-address to-address expiry".
  403.       The 'config' key returns those address mappings set in the
  404.       configuration; the 'cache' key returns the mappings in the
  405.       client-side DNS cache; the 'control' key returns the mappings set
  406.       via the control interface; the 'all' target returns the mappings
  407.       set through any mechanism.
  408.       Expiry is formatted as with ADDRMAP events, except that "expiry" is
  409.       always a time in GMT or the string "NEVER"; see section 4.1.7.
  410.       First introduced in 0.2.0.3-alpha.
  411.  
  412.     "addr-mappings/*" -- as for address-mappings/*, but without the
  413.       expiry portion of the value.  Use of this value is deprecated
  414.       since 0.2.0.3-alpha; use address-mappings instead.
  415.  
  416.     "address" -- the best guess at our external IP address. If we
  417.       have no guess, return a 551 error. (Added in 0.1.2.2-alpha)
  418.  
  419.     "fingerprint" -- the contents of the fingerprint file that Tor
  420.       writes as a server, or a 551 if we're not a server currently.
  421.       (Added in 0.1.2.3-alpha)
  422.  
  423.     "circuit-status"
  424.       A series of lines as for a circuit status event. Each line is of
  425.       the form:
  426.          CircuitID SP CircStatus [SP Path] CRLF
  427.  
  428.     "stream-status"
  429.       A series of lines as for a stream status event.  Each is of the form:
  430.          StreamID SP StreamStatus SP CircID SP Target CRLF
  431.  
  432.     "orconn-status"
  433.       A series of lines as for an OR connection status event.  Each is of the
  434.       form:
  435.          ServerID SP ORStatus CRLF
  436.  
  437.     "entry-guards"
  438.       A series of lines listing the currently chosen entry guards, if any.
  439.       Each is of the form:
  440.          ServerID2 SP Status [SP ISOTime] CRLF
  441.  
  442.          Status-with-time = ("unlisted") SP ISOTime
  443.          Status = ("up" / "never-connected" / "down" /
  444.                       "unusable" / "unlisted" )
  445.  
  446.          ServerID2 = Nickname / 40*HEXDIG
  447.  
  448.       [From 0.1.1.4-alpha to 0.1.1.10-alpha, this was called "helper-nodes".
  449.        Tor still supports calling it that for now, but support will be
  450.        removed in 0.1.3.x.]
  451.  
  452.       [Older versions of Tor (before 0.1.2.x-final) generated 'down' instead
  453.        of unlisted/unusable.  Current Tors never generate 'down'.]
  454.  
  455.       [XXXX ServerID2 differs from ServerID in not prefixing fingerprints
  456.        with a $.  This is an implementation error.  It would be nice to add
  457.        the $ back in if we can do so without breaking compatibility.]
  458.  
  459.     "accounting/enabled"
  460.     "accounting/hibernating"
  461.     "accounting/bytes"
  462.     "accounting/bytes-left"
  463.     "accounting/interval-start"
  464.     "accounting/interval-wake"
  465.     "accounting/interval-end"
  466.       Information about accounting status.  If accounting is enabled,
  467.       "enabled" is 1; otherwise it is 0.  The "hibernating" field is "hard"
  468.       if we are accepting no data; "soft" if we're accepting no new
  469.       connections, and "awake" if we're not hibernating at all.  The "bytes"
  470.       and "bytes-left" fields contain (read-bytes SP write-bytes), for the
  471.       start and the rest of the interval respectively.  The 'interval-start'
  472.       and 'interval-end' fields are the borders of the current interval; the
  473.       'interval-wake' field is the time within the current interval (if any)
  474.       where we plan[ned] to start being active.
  475.  
  476.     "config/names"
  477.       A series of lines listing the available configuration options. Each is
  478.       of the form:
  479.          OptionName SP OptionType [ SP Documentation ] CRLF
  480.          OptionName = Keyword
  481.          OptionType = "Integer" / "TimeInterval" / "DataSize" / "Float" /
  482.            "Boolean" / "Time" / "CommaList" / "Dependant" / "Virtual" /
  483.            "String" / "LineList"
  484.          Documentation = Text
  485.  
  486.     "info/names"
  487.       A series of lines listing the available GETINFO options.  Each is of
  488.       one of these forms:
  489.          OptionName SP Documentation CRLF
  490.          OptionPrefix SP Documentation CRLF
  491.          OptionPrefix = OptionName "/*"
  492.  
  493.     "events/names"
  494.       A space-separated list of all the events supported by this version of
  495.       Tor's SETEVENTS.
  496.  
  497.     "features/names"
  498.       A space-separated list of all the events supported by this version of
  499.       Tor's USEFEATURE.
  500.  
  501.     "next-circuit/IP:port"
  502.       XXX todo.
  503.  
  504.     "dir/status/authority"
  505.     "dir/status/fp/<F>"
  506.     "dir/status/fp/<F1>+<F2>+<F3>"
  507.     "dir/status/all"
  508.     "dir/server/fp/<F>"
  509.     "dir/server/fp/<F1>+<F2>+<F3>"
  510.     "dir/server/d/<D>"
  511.     "dir/server/d/<D1>+<D2>+<D3>"
  512.     "dir/server/authority"
  513.     "dir/server/all"
  514.       A series of lines listing directory contents, provided according to the
  515.       specification for the URLs listed in Section 4.4 of dir-spec.txt.  Note
  516.       that Tor MUST NOT provide private information, such as descriptors for
  517.       routers not marked as general-purpose.  When asked for 'authority'
  518.       information for which this Tor is not authoritative, Tor replies with
  519.       an empty string.
  520.  
  521.     "status/circuit-established"
  522.     "status/enough-dir-info"
  523.     "status/..."
  524.       These provide the current internal Tor values for various Tor
  525.       states. See Section 4.1.10 for explanations. (Only a few of the
  526.       status events are available as getinfo's currently. Let us know if
  527.       you want more exposed.)
  528.     "status/version/recommended" -- List of currently recommended versions
  529.     "status/version/current" -- Status of the current version. One of:
  530.         new, old, unrecommended, recommended, new in series, obsolete.
  531.     "status/version/num-versioning" -- Number of versioning authorities
  532.     "status/version/num-concurring" -- Number of versioning authorities
  533.         agreeing on the status of the current version
  534.  
  535.   Examples:
  536.      C: GETINFO version desc/name/moria1
  537.      S: 250+desc/name/moria=
  538.      S: [Descriptor for moria]
  539.      S: .
  540.      S: 250-version=Tor 0.1.1.0-alpha-cvs
  541.      S: 250 OK
  542.  
  543. 3.10. EXTENDCIRCUIT
  544.  
  545.   Sent from the client to the server.  The format is:
  546.       "EXTENDCIRCUIT" SP CircuitID SP
  547.                       ServerSpec *("," ServerSpec)
  548.                       [SP "purpose=" Purpose] CRLF
  549.  
  550.   This request takes one of two forms: either the CircuitID is zero, in
  551.   which case it is a request for the server to build a new circuit according
  552.   to the specified path, or the CircuitID is nonzero, in which case it is a
  553.   request for the server to extend an existing circuit with that ID according
  554.   to the specified path.
  555.  
  556.   If CircuitID is 0 and "purpose=" is specified, then the circuit's
  557.   purpose is set. Two choices are recognized: "general" and
  558.   "controller". If not specified, circuits are created as "general".
  559.  
  560.   If the request is successful, the server sends a reply containing a
  561.   message body consisting of the CircuitID of the (maybe newly created)
  562.   circuit. The syntax is "250" SP "EXTENDED" SP CircuitID CRLF.
  563.  
  564. 3.11. SETCIRCUITPURPOSE
  565.  
  566.   Sent from the client to the server.  The format is:
  567.       "SETCIRCUITPURPOSE" SP CircuitID SP Purpose CRLF
  568.  
  569.   This changes the circuit's purpose. See EXTENDCIRCUIT above for details.
  570.  
  571. 3.12. SETROUTERPURPOSE
  572.  
  573.   Sent from the client to the server.  The format is:
  574.       "SETROUTERPURPOSE" SP NicknameOrKey SP Purpose CRLF
  575.  
  576.   This changes the descriptor's purpose. See +POSTDESCRIPTOR below
  577.   for details.
  578.  
  579. 3.13. ATTACHSTREAM
  580.  
  581.   Sent from the client to the server.  The syntax is:
  582.      "ATTACHSTREAM" SP StreamID SP CircuitID [SP "HOP=" HopNum] CRLF
  583.  
  584.   This message informs the server that the specified stream should be
  585.   associated with the specified circuit.  Each stream may be associated with
  586.   at most one circuit, and multiple streams may share the same circuit.
  587.   Streams can only be attached to completed circuits (that is, circuits that
  588.   have sent a circuit status 'BUILT' event or are listed as built in a
  589.   GETINFO circuit-status request).
  590.  
  591.   If the circuit ID is 0, responsibility for attaching the given stream is
  592.   returned to Tor.
  593.  
  594.   If HOP=HopNum is specified, Tor will choose the HopNumth hop in the
  595.   circuit as the exit node, rather than the last node in the circuit.
  596.   Hops are 1-indexed; generally, it is not permitted to attach to hop 1.
  597.  
  598.   Tor responds with "250 OK" if it can attach the stream, 552 if the circuit
  599.   or stream didn't exist, or 551 if the stream couldn't be attached for
  600.   another reason.
  601.  
  602.   {Implementation note: Tor will close unattached streams by itself,
  603.   roughly two minutes after they are born. Let the developers know if
  604.   that turns out to be a problem.}
  605.  
  606.   {Implementation note: By default, Tor automatically attaches streams to
  607.   circuits itself, unless the configuration variable
  608.   "__LeaveStreamsUnattached" is set to "1".  Attempting to attach streams
  609.   via TC when "__LeaveStreamsUnattached" is false may cause a race between
  610.   Tor and the controller, as both attempt to attach streams to circuits.}
  611.  
  612.   {Implementation note: You can try to attachstream to a stream that
  613.   has already sent a connect or resolve request but hasn't succeeded
  614.   yet, in which case Tor will detach the stream from its current circuit
  615.   before proceeding with the new attach request.}
  616.  
  617. 3.14. POSTDESCRIPTOR
  618.  
  619.   Sent from the client to the server. The syntax is:
  620.     "+POSTDESCRIPTOR" [SP "purpose=" Purpose] CRLF Descriptor CRLF "." CRLF
  621.  
  622.   This message informs the server about a new descriptor. If Purpose is
  623.   specified, it must be either "general" or "controller", else we
  624.   return a 552 error.
  625.  
  626.   The descriptor, when parsed, must contain a number of well-specified
  627.   fields, including fields for its nickname and identity.
  628.  
  629.   If there is an error in parsing the descriptor, the server must send a "554
  630.   Invalid descriptor" reply.  If the descriptor is well-formed but the server
  631.   chooses not to add it, it must reply with a 251 message whose body explains
  632.   why the server was not added.  If the descriptor is added, Tor replies with
  633.   "250 OK".
  634.  
  635. 3.15. REDIRECTSTREAM
  636.  
  637.   Sent from the client to the server. The syntax is:
  638.     "REDIRECTSTREAM" SP StreamID SP Address [SP Port] CRLF
  639.  
  640.   Tells the server to change the exit address on the specified stream.  If
  641.   Port is specified, changes the destination port as well.  No remapping
  642.   is performed on the new provided address.
  643.  
  644.   To be sure that the modified address will be used, this event must be sent
  645.   after a new stream event is received, and before attaching this stream to
  646.   a circuit.
  647.  
  648.   Tor replies with "250 OK" on success.
  649.  
  650. 3.16. CLOSESTREAM
  651.  
  652.   Sent from the client to the server.  The syntax is:
  653.  
  654.     "CLOSESTREAM" SP StreamID SP Reason *(SP Flag) CRLF
  655.  
  656.   Tells the server to close the specified stream.  The reason should be one
  657.   of the Tor RELAY_END reasons given in tor-spec.txt, as a decimal.  Flags is
  658.   not used currently; Tor servers SHOULD ignore unrecognized flags.  Tor may
  659.   hold the stream open for a while to flush any data that is pending.
  660.  
  661.   Tor replies with "250 OK" on success, or a 512 if there aren't enough
  662.   arguments, or a 552 if it doesn't recognize the StreamID or reason.
  663.  
  664. 3.17. CLOSECIRCUIT
  665.  
  666.    The syntax is:
  667.      CLOSECIRCUIT SP CircuitID *(SP Flag) CRLF
  668.      Flag = "IfUnused"
  669.  
  670.   Tells the server to close the specified circuit.   If "IfUnused" is
  671.   provided, do not close the circuit unless it is unused.
  672.  
  673.   Other flags may be defined in the future; Tor SHOULD ignore unrecognized
  674.   flags.
  675.  
  676.   Tor replies with "250 OK" on success, or a 512 if there aren't enough
  677.   arguments, or a 552 if it doesn't recognize the CircuitID.
  678.  
  679. 3.18. QUIT
  680.  
  681.   Tells the server to hang up on this controller connection. This command
  682.   can be used before authenticating.
  683.  
  684. 3.19. USEFEATURE
  685.  
  686.   The syntax is:
  687.  
  688.     "USEFEATURE" *(SP FeatureName) CRLF
  689.     FeatureName = 1*(ALPHA / DIGIT / "_" / "-")
  690.  
  691.   Sometimes extensions to the controller protocol break compatibility with
  692.   older controllers.  In this case, whenever possible, the extensions are
  693.   first included in Tor disabled by default, and only enabled on a given
  694.   controller connection when the "USEFEATURE" command is given.  Once a
  695.   "USEFEATURE" command is given, it applies to all subsequent interactions on
  696.   the same connection; to disable an enabled feature, a new controller
  697.   connection must be opened.
  698.  
  699.   This is a forward-compatibility mechanism; each feature will eventually
  700.   become a regular part of the control protocol in some future version of Tor.
  701.   Tor will ignore a request to use any feature that is already on by default.
  702.   Tor will give a "552" error if any requested feature is not recognized.
  703.  
  704.   Feature names are case-insensitive.
  705.  
  706.   EXTENDED_EVENTS
  707.  
  708.      Same as passing 'EXTENDED' to SETEVENTS; this is the preferred way to
  709.      request the extended event syntax.
  710.  
  711.      This will not be always-enabled until at least XXX (or, at least two
  712.      stable releases after XXX, the release where it was first used for
  713.      anything.)
  714.  
  715.   VERBOSE_NAMES
  716.  
  717.      Instead of ServerID as specified above, the controller should
  718.      identify ORs by LongName in events and GETINFO results.  This format is
  719.      strictly more informative: rather than including Nickname for
  720.      known Named routers and Fingerprint for unknown or unNamed routers, the
  721.      LongName format includes a Fingerprint, an indication of Named status,
  722.      and a Nickname (if one is known).
  723.  
  724.      This will not be always-enabled until at least 0.1.4.x (or at least two
  725.      stable releases after 0.1.2.2-alpha, the release where it was first
  726.      available.)
  727.  
  728. 3.20. RESOLVE
  729.  
  730.   The syntax is
  731.     "RESOLVE" *Option *Address CRLF
  732.     Option = "mode=reverse"
  733.     Address = a hostname or IPv4 address
  734.  
  735.   This command launches a remote hostname lookup request for every specified
  736.   request (or reverse lookup if "mode=reverse" is specified).  Note that the
  737.   request is done in the background: to see the answers, your controller will
  738.   need to listen for ADDRMAP events; see 4.1.7 below.
  739.  
  740.   [Added in Tor 0.2.0.3-alpha]
  741.  
  742. 3.21. PROTOCOLINFO
  743.  
  744.   The syntax is:
  745.     "PROTOCOLINFO" *(SP PIVERSION) CRLF
  746.  
  747.   The server reply format is:
  748.     "250-PROTOCOLINFO" SP PIVERSION CRLF *InfoLine "250 OK" CRLF
  749.  
  750.     InfoLine = AuthLine / VersionLine / OtherLine
  751.  
  752.      AuthLine = "250-AUTH" SP "METHODS=" AuthMethod *(",")AuthMethod
  753.                        *(SP "COOKIEFILE=" AuthCookieFile) CRLF
  754.      VersionLine = "250-VERSION" SP "Tor=" TorVersion [SP Arguments] CRLF
  755.  
  756.      AuthMethod =
  757.       "NULL"           / ; No authentication is required
  758.       "HASHEDPASSWORD" / ; A controller must supply the original password
  759.       "COOKIE"         / ; A controller must supply the contents of a cookie
  760.  
  761.      AuthCookieFile = QuotedString
  762.      TorVersion = QuotedString
  763.  
  764.      OtherLine = "250-" Keyword [SP Arguments] CRLF
  765.  
  766.     PIVERSION: 1*DIGIT
  767.  
  768.   Tor MAY give its InfoLines in any order; controllers MUST ignore InfoLines
  769.   with keywords they do not recognize.  Controllers MUST ignore extraneous
  770.   data on any InfoLine.
  771.  
  772.   PIVERSION is there in case we drastically change the syntax one day. For
  773.   now it should always be "1".  Controllers MAY provide a list of the
  774.   protocolinfo versions they support; Tor MAY select a version that the
  775.   controller does not support.
  776.  
  777.   AuthMethod is used to specify one or more control authentication
  778.   methods that Tor currently accepts.
  779.  
  780.   AuthCookieFile specifies the absolute path and filename of the
  781.   authentication cookie that Tor is expecting and is provided iff
  782.   the METHODS field contains the method "COOKIE".  Controllers MUST handle
  783.   escape sequences inside this string.
  784.  
  785.   The VERSION line contains the Tor version.
  786.  
  787.   [Unlike other commands besides AUTHENTICATE, PROTOCOLINFO may be used (but
  788.   only once!) before AUTHENTICATE.]
  789.  
  790.   [PROTOCOLINFO was not supported before Tor 0.2.0.5-alpha.]
  791.  
  792. 4. Replies
  793.  
  794.   Reply codes follow the same 3-character format as used by SMTP, with the
  795.   first character defining a status, the second character defining a
  796.   subsystem, and the third designating fine-grained information.
  797.  
  798.   The TC protocol currently uses the following first characters:
  799.  
  800.     2yz   Positive Completion Reply
  801.        The command was successful; a new request can be started.
  802.  
  803.     4yz   Temporary Negative Completion reply
  804.        The command was unsuccessful but might be reattempted later.
  805.  
  806.     5yz   Permanent Negative Completion Reply
  807.        The command was unsuccessful; the client should not try exactly
  808.        that sequence of commands again.
  809.  
  810.     6yz   Asynchronous Reply
  811.        Sent out-of-order in response to an earlier SETEVENTS command.
  812.  
  813.   The following second characters are used:
  814.  
  815.     x0z   Syntax
  816.        Sent in response to ill-formed or nonsensical commands.
  817.  
  818.     x1z   Protocol
  819.        Refers to operations of the Tor Control protocol.
  820.  
  821.     x5z   Tor
  822.        Refers to actual operations of Tor system.
  823.  
  824.   The following codes are defined:
  825.  
  826.      250 OK
  827.      251 Operation was unnecessary
  828.          [Tor has declined to perform the operation, but no harm was done.]
  829.  
  830.      451 Resource exhausted
  831.  
  832.      500 Syntax error: protocol
  833.  
  834.      510 Unrecognized command
  835.      511 Unimplemented command
  836.      512 Syntax error in command argument
  837.      513 Unrecognized command argument
  838.      514 Authentication required
  839.      515 Bad authentication
  840.  
  841.      550 Unspecified Tor error
  842.  
  843.      551 Internal error
  844.                [Something went wrong inside Tor, so that the client's
  845.                 request couldn't be fulfilled.]
  846.  
  847.      552 Unrecognized entity
  848.                [A configuration key, a stream ID, circuit ID, event,
  849.                 mentioned in the command did not actually exist.]
  850.  
  851.      553 Invalid configuration value
  852.          [The client tried to set a configuration option to an
  853.            incorrect, ill-formed, or impossible value.]
  854.  
  855.      554 Invalid descriptor
  856.  
  857.      555 Unmanaged entity
  858.  
  859.      650 Asynchronous event notification
  860.  
  861.   Unless specified to have specific contents, the human-readable messages
  862.   in error replies should not be relied upon to match those in this document.
  863.  
  864. 4.1. Asynchronous events
  865.  
  866.   These replies can be sent after a corresponding SETEVENTS command has been
  867.   received.  They will not be interleaved with other Reply elements, but they
  868.   can appear between a command and its corresponding reply.  For example,
  869.   this sequence is possible:
  870.  
  871.      C: SETEVENTS CIRC
  872.      S: 250 OK
  873.      C: GETCONF SOCKSPORT ORPORT
  874.      S: 650 CIRC 1000 EXTENDED moria1,moria2
  875.      S: 250-SOCKSPORT=9050
  876.      S: 250 ORPORT=0
  877.  
  878.   But this sequence is disallowed:
  879.      C: SETEVENTS CIRC
  880.      S: 250 OK
  881.      C: GETCONF SOCKSPORT ORPORT
  882.      S: 250-SOCKSPORT=9050
  883.      S: 650 CIRC 1000 EXTENDED moria1,moria2
  884.      S: 250 ORPORT=0
  885.  
  886.   Clients MUST tolerate more arguments in an asynchonous reply than
  887.   expected, and MUST tolerate more lines in an asynchronous reply than
  888.   expected.  For instance, a client that expects a CIRC message like:
  889.       650 CIRC 1000 EXTENDED moria1,moria2
  890.   must tolerate:
  891.       650-CIRC 1000 EXTENDED moria1,moria2 0xBEEF
  892.       650-EXTRAMAGIC=99
  893.       650 ANONYMITY=high
  894.  
  895.   If clients ask for extended events, then each event line as specified below
  896.   will be followed by additional extensions. Additional lines will be of the
  897.   form
  898.       "650" ("-"/" ") KEYWORD ["=" ARGUMENTS] CRLF
  899.   Additional arguments will be of the form
  900.       SP KEYWORD ["=" ( QuotedString / * NonSpDquote ) ]
  901.   Such clients MUST tolerate lines with keywords they do not recognize.
  902.  
  903. 4.1.1. Circuit status changed
  904.  
  905.    The syntax is:
  906.  
  907.      "650" SP "CIRC" SP CircuitID SP CircStatus [SP Path]
  908.           [SP "REASON=" Reason [SP "REMOTE_REASON=" Reason]] CRLF
  909.  
  910.       CircStatus =
  911.                "LAUNCHED" / ; circuit ID assigned to new circuit
  912.                "BUILT"    / ; all hops finished, can now accept streams
  913.                "EXTENDED" / ; one more hop has been completed
  914.                "FAILED"   / ; circuit closed (was not built)
  915.                "CLOSED"     ; circuit closed (was built)
  916.  
  917.       Path = ServerID *("," ServerID)
  918.  
  919.       Reason = "NONE" / "TORPROTOCOL" / "INTERNAL" / "REQUESTED" /
  920.                "HIBERNATING" / "RESOURCELIMIT" / "CONNECTFAILED" /
  921.                "OR_IDENTITY" / "OR_CONN_CLOSED" / "TIMEOUT" /
  922.                "FINISHED" / "DESTROYED" / "NOPATH" / "NOSUCHSERVICE"
  923.  
  924.    The path is provided only when the circuit has been extended at least one
  925.    hop.
  926.  
  927.    The "REASON" field is provided only for FAILED and CLOSED events, and only
  928.    if extended events are enabled (see 3.19).  Clients MUST accept reasons
  929.    not listed above.  Reasons are as given in tor-spec.txt, except for:
  930.  
  931.       NOPATH          (Not enough nodes to make circuit)
  932.  
  933.    The "REMOTE_REASON" field is provided only when we receive a DESTROY or
  934.    TRUNCATE cell, and only if extended events are enabled.  It contains the
  935.    actual reason given by the remote OR for closing the circuit. Clients MUST
  936.    accept reasons not listed above.  Reasons are as listed in tor-spec.txt.
  937.  
  938. 4.1.2. Stream status changed
  939.  
  940.     The syntax is:
  941.  
  942.       "650" SP "STREAM" SP StreamID SP StreamStatus SP CircID SP Target
  943.           [SP "REASON=" Reason [ SP "REMOTE_REASON=" Reason ]]
  944.           [SP "SOURCE=" Source] [ SP "SOURCE_ADDR=" Address ":" Port ]
  945.           CRLF
  946.  
  947.       StreamStatus =
  948.                "NEW"          / ; New request to connect
  949.                "NEWRESOLVE"   / ; New request to resolve an address
  950.                "REMAP"        / ; Address re-mapped to another
  951.                "SENTCONNECT"  / ; Sent a connect cell along a circuit
  952.                "SENTRESOLVE"  / ; Sent a resolve cell along a circuit
  953.                "SUCCEEDED"    / ; Received a reply; stream established
  954.                "FAILED"       / ; Stream failed and not retriable
  955.                "CLOSED"       / ; Stream closed
  956.                "DETACHED"       ; Detached from circuit; still retriable
  957.  
  958.        Target = Address ":" Port
  959.  
  960.   The circuit ID designates which circuit this stream is attached to.  If
  961.   the stream is unattached, the circuit ID "0" is given.
  962.  
  963.       Reason = "MISC" / "RESOLVEFAILED" / "CONNECTREFUSED" /
  964.                "EXITPOLICY" / "DESTROY" / "DONE" / "TIMEOUT" /
  965.                "HIBERNATING" / "INTERNAL"/ "RESOURCELIMIT" /
  966.                "CONNRESET" / "TORPROTOCOL" / "NOTDIRECTORY" / "END"
  967.  
  968.    The "REASON" field is provided only for FAILED, CLOSED, and DETACHED
  969.    events, and only if extended events are enabled (see 3.19).  Clients MUST
  970.    accept reasons not listed above.  Reasons are as given in tor-spec.txt,
  971.    except for:
  972.  
  973.       END          (We received a RELAY_END cell from the other side of thise
  974.                     stream.)
  975.       [XXXX document more.]
  976.  
  977.    The "REMOTE_REASON" field is provided only when we receive a RELAY_END
  978.    cell, and only if extended events are enabled.  It contains the actual
  979.    reason given by the remote OR for closing the stream. Clients MUST accept
  980.    reasons not listed above.  Reasons are as listed in tor-spec.txt.
  981.  
  982.    "REMAP" events include a Source if extended events are enabled:
  983.       Source = "CACHE" / "EXIT"
  984.    Clients MUST accept sources not listed above.  "CACHE" is given if
  985.    the Tor client decided to remap the address because of a cached
  986.    answer, and "EXIT" is given if the remote node we queried gave us
  987.    the new address as a response.
  988.  
  989.    The "SOURCE_ADDR" field is included with NEW and NEWRESOLVE events if
  990.    extended events are enabled.  It indicates the address and port
  991.    that requested the connection, and can be (e.g.) used to look up the
  992.    requesting program.
  993.  
  994. 4.1.3. OR Connection status changed
  995.  
  996.   The syntax is:
  997.     "650" SP "ORCONN" SP (ServerID / Target) SP ORStatus [ SP "REASON="
  998.              Reason ] [ SP "NCIRCS=" NumCircuits ] CRLF
  999.  
  1000.     ORStatus = "NEW" / "LAUNCHED" / "CONNECTED" / "FAILED" / "CLOSED"
  1001.  
  1002.   NEW is for incoming connections, and LAUNCHED is for outgoing
  1003.   connections. CONNECTED means the TLS handshake has finished (in
  1004.   either direction). FAILED means a connection is being closed that
  1005.   hasn't finished its handshake, and CLOSED is for connections that
  1006.   have handshaked.
  1007.  
  1008.   A ServerID is specified unless it's a NEW connection, in which
  1009.   case we don't know what server it is yet, so we use Address:Port.
  1010.  
  1011.   If extended events are enabled (see 3.19), optional reason and
  1012.   circuit counting information is provided for CLOSED and FAILED
  1013.   events.
  1014.  
  1015.       Reason = "MISC" / "DONE" / "CONNECTREFUSED" /
  1016.                "IDENTITY" / "CONNECTRESET" / "TIMEOUT" / "NOROUTE" /
  1017.                "IOERROR"
  1018.  
  1019.   NumCircuits counts both established and pending circuits.
  1020.  
  1021. 4.1.4. Bandwidth used in the last second
  1022.  
  1023.   The syntax is:
  1024.      "650" SP "BW" SP BytesRead SP BytesWritten *(SP Type "=" Num) CRLF
  1025.      BytesRead = 1*DIGIT
  1026.      BytesWritten = 1*DIGIT
  1027.      Type = "DIR" / "OR" / "EXIT" / "APP" / ...
  1028.      Num = 1*DIGIT
  1029.  
  1030.   BytesRead and BytesWritten are the totals. In Tor 0.1.x.y-alpha
  1031.   and later, we also include a breakdown of the connection types
  1032.   that used bandwidth this second (not implemented yet).
  1033.  
  1034. 4.1.5. Log messages
  1035.  
  1036.   The syntax is:
  1037.      "650" SP Severity SP ReplyText CRLF
  1038.   or
  1039.      "650+" Severity CRLF Data 650 SP "OK" CRLF
  1040.  
  1041.      Severity = "DEBUG" / "INFO" / "NOTICE" / "WARN"/ "ERR"
  1042.  
  1043. 4.1.6. New descriptors available
  1044.  
  1045.   Syntax:
  1046.      "650" SP "NEWDESC" 1*(SP ServerID) CRLF
  1047.  
  1048. 4.1.7. New Address mapping
  1049.  
  1050.   Syntax:
  1051.      "650" SP "ADDRMAP" SP Address SP NewAddress SP Expiry
  1052.        [SP Error] SP GMTExpiry CRLF
  1053.  
  1054.      NewAddress = Address / "<error>"
  1055.      Expiry = DQUOTE ISOTime DQUOTE / "NEVER"
  1056.  
  1057.      Error = "error=" ErrorCode
  1058.      ErrorCode = XXXX
  1059.      GMTExpiry = "EXPIRES=" DQUOTE IsoTime DQUOTE
  1060.  
  1061.   Error and GMTExpiry are only provided if extended events are enabled.
  1062.  
  1063.   Expiry is expressed as the local time (rather than GMT).  This is a bug,
  1064.   left in for backward compatibility; new code should look at GMTExpiry
  1065.   instead.
  1066.  
  1067.   These events are generated when a new address mapping is entered in the
  1068.   cache, or when the answer for a RESOLVE command is found.
  1069.  
  1070. 4.1.8. Descriptors uploaded to us in our role as authoritative dirserver
  1071.  
  1072.   Syntax:
  1073.      "650" "+" "AUTHDIR_NEWDESCS" CRLF Action CRLF Message CRLF
  1074.        Descriptor CRLF "." CRLF "650" SP "OK" CRLF
  1075.      Action = "ACCEPTED" / "DROPPED" / "REJECTED"
  1076.      Message = Text
  1077.  
  1078. 4.1.9. Our descriptor changed
  1079.  
  1080.   Syntax:
  1081.      "650" SP "DESCCHANGED" CRLF
  1082.  
  1083.   [First added in 0.1.2.2-alpha.]
  1084.  
  1085. 4.1.10. Status events
  1086.  
  1087.   Status events (STATUS_GENERAL, STATUS_CLIENT, and STATUS_SERVER) are sent
  1088.   based on occurrences in the Tor process pertaining to the general state of
  1089.   the program.  Generally, they correspond to log messages of severity Notice
  1090.   or higher.  They differ from log messages in that their format is a
  1091.   specified interface.
  1092.  
  1093.   Syntax:
  1094.      "650" SP StatusType SP StatusSeverity SP StatusAction
  1095.                                          [SP StatusArguments] CRLF
  1096.  
  1097.      StatusType = "STATUS_GENERAL" / "STATUS_CLIENT" / "STATUS_SERVER"
  1098.      StatusSeverity = "NOTICE" / "WARN" / "ERR"
  1099.      StatusAction = 1*ALPHA
  1100.      StatusArguments = StatusArgument *(SP StatusArgument)
  1101.      StatusArgument = StatusKeyword '=' StatusValue
  1102.      StatusKeyword = 1*(ALNUM / "_")
  1103.      StatusValue = 1*(ALNUM / '_')  / QuotedString
  1104.  
  1105.      Action is a string, and Arguments is a series of keyword=value
  1106.      pairs on the same line.  Values may be space-terminated strings,
  1107.      or quoted strings.
  1108.  
  1109.      These events are always produced with EXTENDED_EVENTS and
  1110.      VERBOSE_NAMES; see the explanations in the USEFEATURE section
  1111.      for details.
  1112.  
  1113.      Controllers MUST tolerate unrecognized actions, MUST tolerate
  1114.      unrecognized arguments, MUST tolerate missing arguments, and MUST
  1115.      tolerate arguments that arrive in any order.
  1116.  
  1117.      Each event description below is accompanied by a recommendation for
  1118.      controllers.  These recommendations are suggestions only; no controller
  1119.      is required to implement them.
  1120.  
  1121.   Actions for STATUS_GENERAL events can be as follows:
  1122.  
  1123.      CLOCK_JUMPED
  1124.      "TIME=NUM"
  1125.        Tor spent enough time without CPU cycles that it has closed all
  1126.        its circuits and will establish them anew. This typically
  1127.        happens when a laptop goes to sleep and then wakes up again. It
  1128.        also happens when the system is swapping so heavily that Tor is
  1129.        starving. The "time" argument specifies the number of seconds Tor
  1130.        thinks it was unconscious for (or alternatively, the number of
  1131.        seconds it went back in time).
  1132.  
  1133.        This status event is sent as NOTICE severity normally, but WARN
  1134.        severity if Tor is acting as a server currently.
  1135.  
  1136.        {Recommendation for controller: ignore it, since we don't really
  1137.        know what the user should do anyway. Hm.}
  1138.  
  1139.      DANGEROUS_VERSION
  1140.      "CURRENT=version"
  1141.      "REASON=NEW/OLD/UNRECOMMENDED"
  1142.      "RECOMMENDED=\"version, version, ...\""
  1143.        Tor has found that directory servers don't recommend its version of
  1144.        the Tor software.  RECOMMENDED is a comma-and-space-separated string
  1145.        of Tor versions that are recommended.  REASON is NEW if this version
  1146.        of Tor is newer than any recommended version, OLD if this version of
  1147.        Tor is older than any recommended version, and UNRECOMMENDED if
  1148.        some recommended versions of Tor are newer and some are old than this
  1149.        version.
  1150.  
  1151.        {Controllers may want to suggest that the user upgrade OLD or
  1152.        UNRECOMMENDED versions.  NEW versions may be known-insecure, or may
  1153.        simply be development versions.}
  1154.  
  1155.      TOO_MANY_CONNECTIONS
  1156.      "CURRENT=NUM"
  1157.        Tor has reached its ulimit -n or whatever the native limit is on file
  1158.        descriptors or sockets.  CURRENT is the number of sockets Tor
  1159.        currently has open.  The user should really do something about
  1160.        this. The "current" argument shows the number of connections currently
  1161.        open.
  1162.  
  1163.        {Controllers may recommend that the user increase the limit, or
  1164.        increase it for them.  Recommendations should be phrased in an
  1165.        OS-appropriate way and automated when possible.}
  1166.  
  1167.      BUG
  1168.      "REASON=STRING"
  1169.        Tor has encountered a situation that its developers never expected,
  1170.        and the developers would like to learn that it happened. Perhaps
  1171.        the controller can explain this to the user and encourage her to
  1172.        file a bug report?
  1173.  
  1174.        {Controllers should log bugs, but shouldn't annoy the user in case a
  1175.        bug appears frequently.}
  1176.  
  1177.      CLOCK_SKEWED
  1178.        SKEW="+" / "-" SECONDS
  1179.        SOURCE="DIRSERV:IP:Port" / "NETWORKSTATUS:IP:PORT"
  1180.          If "SKEW" is present, it's an estimate of how far we are from the
  1181.          time declared in the source.  If the source is a DIRSERV, we got
  1182.          the current time from a connection to a dirserver.  If the source is
  1183.          a NETWORKSTATUS, we decided we're skewed because we got a
  1184.          networkstatus from far in the future.
  1185.  
  1186.          {Controllers may want to warn the user if the skew is high, or if
  1187.          multiple skew messages appear at severity WARN.  Controllers
  1188.          shouldn't blindly adjust the clock, since the more accurate source
  1189.          of skew info (DIRSERV) is currently unauthenticated.}
  1190.  
  1191.      BAD_LIBEVENT
  1192.      "METHOD=" libevent method
  1193.      "VERSION=" libevent version
  1194.      "BADNESS=" "BROKEN" / "BUGGY" / "SLOW"
  1195.      "RECOVERED=" "NO" / "YES"
  1196.         Tor knows about bugs in using the configured event method in this
  1197.         version of libevent.  "BROKEN" libevents won't work at all;
  1198.         "BUGGY" libevents might work okay; "SLOW" libevents will work
  1199.         fine, but not quickly.  If "RECOVERED" is YES, Tor managed to
  1200.         switch to a more reliable (but probably slower!) libevent method.
  1201.  
  1202.         {Controllers may want to warn the user if this event occurs, though
  1203.         generally it's the fault of whoever built the Tor binary and there's
  1204.         not much the user can do besides upgrade libevent or upgrade the
  1205.         binary.}
  1206.  
  1207.      DIR_ALL_UNREACHABLE
  1208.        Tor believes that none of the known directory servers are
  1209.        reachable -- this is most likely because the local network is
  1210.        down or otherwise not working, and might help to explain for the
  1211.        user why Tor appears to be broken.
  1212.  
  1213.        {Controllers may want to warn the user if this event occurs; further
  1214.        action is generally not possible.}
  1215.  
  1216.   Actions for STATUS_CLIENT events can be as follows:
  1217.  
  1218.      ENOUGH_DIR_INFO
  1219.        Tor now knows enough network-status documents and enough server
  1220.        descriptors that it's going to start trying to build circuits now.
  1221.  
  1222.        {Controllers may want to use this event to decide when to indicate
  1223.        progress to their users, but should not interrupt the user's browsing
  1224.        to tell them so.}
  1225.  
  1226.      NOT_ENOUGH_DIR_INFO
  1227.        We discarded expired statuses and router descriptors to fall
  1228.        below the desired threshold of directory information. We won't
  1229.        try to build any circuits until ENOUGH_DIR_INFO occurs again.
  1230.  
  1231.        {Controllers may want to use this event to decide when to indicate
  1232.        progress to their users, but should not interrupt the user's browsing
  1233.        to tell them so.}
  1234.  
  1235.      CIRCUIT_ESTABLISHED
  1236.        Tor is able to establish circuits for client use. This event will
  1237.        only be sent if we just built a circuit that changed our mind --
  1238.        that is, prior to this event we didn't know whether we could
  1239.        establish circuits.
  1240.  
  1241.        {Suggested use: controllers can notify their users that Tor is
  1242.        ready for use as a client once they see this status event. [Perhaps
  1243.        controllers should also have a timeout if too much time passes and
  1244.        this event hasn't arrived, to give tips on how to troubleshoot.
  1245.        On the other hand, hopefully Tor will send further status events
  1246.        if it can identify the problem.]}
  1247.  
  1248.      CIRCUIT_NOT_ESTABLISHED
  1249.      "REASON=" "EXTERNAL_ADDRESS" / "DIR_ALL_UNREACHABLE" / "CLOCK_JUMPED"
  1250.        We are no longer confident that we can build circuits. The "reason"
  1251.        keyword provides an explanation: which other status event type caused
  1252.        our lack of confidence.
  1253.  
  1254.        {Controllers may want to use this event to decide when to indicate
  1255.        progress to their users, but should not interrupt the user's browsing
  1256.        to do so.}
  1257.        [Note: only REASON=CLOCK_JUMPED is implemented currently.]
  1258.  
  1259.      DANGEROUS_SOCKS
  1260.      "PROTOCOL=SOCKS4/SOCKS5"
  1261.      "ADDRESS=IP:port"
  1262.        A connection was made to Tor's SOCKS port using one of the SOCKS
  1263.        approaches that doesn't support hostnames -- only raw IP addresses.
  1264.        If the client application got this address from gethostbyname(),
  1265.        it may be leaking target addresses via DNS.
  1266.  
  1267.        {Controllers should warn their users when this occurs, unless they
  1268.        happen to know that the application using Tor is in fact doing so
  1269.        correctly (e.g., because it is part of a distributed bundle).}
  1270.  
  1271.      SOCKS_UNKNOWN_PROTOCOL
  1272.        "DATA=string"
  1273.        A connection was made to Tor's SOCKS port that tried to use it
  1274.        for something other than the SOCKS protocol. Perhaps the user is
  1275.        using Tor as an HTTP proxy?   The DATA is the first few characters
  1276.        sent to Tor on the SOCKS port.
  1277.  
  1278.        {Controllers may want to warn their users when this occurs: it
  1279.        indicates a misconfigured application.}
  1280.  
  1281.      SOCKS_BAD_HOSTNAME
  1282.       "HOSTNAME=QuotedString"
  1283.        Some application gave us a funny-looking hostname. Perhaps
  1284.        it is broken? In any case it won't work with Tor and the user
  1285.        should know.
  1286.  
  1287.        {Controllers may want to warn their users when this occurs: it
  1288.        usually indicates a misconfigured application.}
  1289.  
  1290.   Actions for STATUS_SERVER can be as follows:
  1291.  
  1292.      EXTERNAL_ADDRESS
  1293.      "ADDRESS=IP"
  1294.      "HOSTNAME=NAME"
  1295.      "METHOD=CONFIGURED/DIRSERV/RESOLVED/INTERFACE/GETHOSTNAME"
  1296.        Our best idea for our externally visible IP has changed to 'IP'.
  1297.        If 'HOSTNAME' is present, we got the new IP by resolving 'NAME'.  If the
  1298.        method is 'CONFIGURED', the IP was given verbatim as a configuration
  1299.        option.  If the method is 'RESOLVED', we resolved the Address
  1300.        configuration option to get the IP.  If the method is 'GETHOSTNAME',
  1301.        we resolved our hostname to get the IP.  If the method is 'INTERFACE',
  1302.        we got the address of one of our network interfaces to get the IP.  If
  1303.        the method is 'DIRSERV', a directory server told us a guess for what
  1304.        our IP might be.
  1305.  
  1306.        {Controllers may want to record this info and display it to the user.}
  1307.  
  1308.      CHECKING_REACHABILITY
  1309.      "ORADDRESS=IP:port"
  1310.      "DIRADDRESS=IP:port"
  1311.        We're going to start testing the reachability of our external OR port
  1312.        or directory port.
  1313.  
  1314.        {This event could effect the controller's idea of server status, but
  1315.        the controller should not interrupt the user to tell them so.}
  1316.  
  1317.      REACHABILITY_SUCCEEDED
  1318.      "ORADDRESS=IP:port"
  1319.      "DIRADDRESS=IP:port"
  1320.        We successfully verified the reachability of our external OR port or
  1321.        directory port.
  1322.  
  1323.        {This event could effect the controller's idea of server status, but
  1324.        the controller should not interrupt the user to tell them so.}
  1325.  
  1326.      GOOD_SERVER_DESCRIPTOR
  1327.        We successfully uploaded our server descriptor to each of the
  1328.        directory authorities, with no complaints.
  1329.  
  1330.        {This event could effect the controller's idea of server status, but
  1331.        the controller should not interrupt the user to tell them so.}
  1332.  
  1333.      NAMESERVER_STATUS
  1334.      "NS=addr"
  1335.      "STATUS=" "UP" / "DOWN"
  1336.      "ERR=" message
  1337.         One of our nameservers has changed status.
  1338.         // actually notice
  1339.  
  1340.        {This event could effect the controller's idea of server status, but
  1341.        the controller should not interrupt the user to tell them so.}
  1342.  
  1343.      NAMESERVER_ALL_DOWN
  1344.         All of our nameservers have gone down.
  1345.  
  1346.         {This is a problem; if it happens often without the nameservers
  1347.         coming up again, the user needs to configure more or better
  1348.         nameservers.}
  1349.  
  1350.      DNS_HIJACKED
  1351.         Our DNS provider is providing an address when it should be saying
  1352.         "NOTFOUND"; Tor will treat the address as a synonym for "NOTFOUND".
  1353.  
  1354.         {This is an annoyance; controllers may want to tell admins that their
  1355.         DNS provider is not to be trusted.}
  1356.  
  1357.      DNS_USELESS
  1358.         Our DNS provider is giving a hijacked address instead of well-known
  1359.         websites; Tor will not try to be an exit node.
  1360.  
  1361.         {Controllers could warn the admin if the server is running as an
  1362.         exit server: the admin needs to configure a good DNS server.
  1363.         Alternatively, this happens a lot in some restrictive environments
  1364.         (hotels, universities, coffeeshops) when the user hasn't registered.}
  1365.  
  1366.      BAD_SERVER_DESCRIPTOR
  1367.      "DIRAUTH=addr:port"
  1368.      "REASON=string"
  1369.         A directory authority rejected our descriptor.  Possible reasons
  1370.         include malformed descriptors, incorrect keys, highly skewed clocks,
  1371.         and so on.
  1372.  
  1373.         {Controllers should warn the admin, and try to cope if they can.}
  1374.  
  1375.      ACCEPTED_SERVER_DESCRIPTOR
  1376.      "DIRAUTH=addr:port"
  1377.         A single directory authority accepted our descriptor.
  1378.         // actually notice
  1379.  
  1380.        {This event could effect the controller's idea of server status, but
  1381.        the controller should not interrupt the user to tell them so.}
  1382.  
  1383.      REACHABILITY_FAILED
  1384.      "ORADDRESS=IP:port"
  1385.      "DIRADDRESS=IP:port"
  1386.        We failed to connect to our external OR port or directory port
  1387.        successfully.
  1388.  
  1389.        {This event could effect the controller's idea of server status.  The
  1390.        controller should warn the admin and suggest reasonable steps to take.}
  1391.  
  1392. 4.1.11. Our set of guard nodes has changed
  1393.  
  1394.   Syntax:
  1395.      "650" SP "GUARD" SP Type SP Name SP Status ... CRLF
  1396.      Type = "ENTRY"
  1397.      Name = The (possibly verbose) nickname of the guard affected.
  1398.      Status = "NEW" | "UP" | "DOWN" | "BAD" | "GOOD" | "DROPPED"
  1399.  
  1400.   [explain states. XXX]
  1401.  
  1402. 4.1.12. Network status has changed
  1403.  
  1404.   Syntax:
  1405.      "650" "+" "NS" CRLF  1*NetworkStatus "." CRLF "650" SP "OK" CRLF
  1406.  
  1407.   [First added in 0.1.2.3-alpha]
  1408.  
  1409. 4.1.13. Bandwidth used on an application stream
  1410.  
  1411.   The syntax is:
  1412.      "650" SP "STREAM_BW" SP StreamID SP BytesRead SP BytesWritten CRLF
  1413.      BytesRead = 1*DIGIT
  1414.      BytesWritten = 1*DIGIT
  1415.  
  1416.   BytesRead and BytesWritten are the number of bytes read and written since
  1417.   the last STREAM_BW event on this stream.  These events are generated about
  1418.   once per second per stream; no events are generated for streams that have
  1419.   not read or written.
  1420.  
  1421.   These events apply only to streams entering Tor (such as on a SOCKSPort,
  1422.   TransPort, or so on).  They are not generated for exiting streams.
  1423.  
  1424. 5. Implementation notes
  1425.  
  1426. 5.1. Authentication
  1427.  
  1428.   By default, the current Tor implementation trusts all local users.
  1429.  
  1430.   If the 'CookieAuthentication' option is true, Tor writes a "magic cookie"
  1431.   file named "control_auth_cookie" into its data directory.  To authenticate,
  1432.   the controller must send the contents of this file, encoded in hexadecimal.
  1433.  
  1434.   If the 'HashedControlPassword' option is set, it must contain the salted
  1435.   hash of a secret password.  The salted hash is computed according to the
  1436.   S2K algorithm in RFC 2440 (OpenPGP), and prefixed with the s2k specifier.
  1437.   This is then encoded in hexadecimal, prefixed by the indicator sequence
  1438.   "16:".  Thus, for example, the password 'foo' could encode to:
  1439.      16:660537E3E1CD49996044A3BF558097A981F539FEA2F9DA662B4626C1C2
  1440.         ++++++++++++++++**^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  1441.            salt                       hashed value
  1442.                        indicator
  1443.   You can generate the salt of a password by calling
  1444.            'tor --hash-password <password>'
  1445.   or by using the example code in the Python and Java controller libraries.
  1446.   To authenticate under this scheme, the controller sends Tor the original
  1447.   secret that was used to generate the password.
  1448.  
  1449. 5.2. Don't let the buffer get too big.
  1450.  
  1451.   If you ask for lots of events, and 16MB of them queue up on the buffer,
  1452.   the Tor process will close the socket.
  1453.  
  1454. 5.3. Backward compatibility with v0 control protocol.
  1455.  
  1456.   The 'version 0' control protocol was replaced in Tor 0.1.1.x.  Support was
  1457.   removed in Tor 0.2.0.x.  Every non-obsolete version of Tor now supports the
  1458.   version 1 control protocol.
  1459.  
  1460.   For backward compatibility with the "version 0" control protocol,
  1461.   Tor used to check whether the third octet of the first command is zero.
  1462.   (If it was, Tor assumed that version 0 is in use.)
  1463.  
  1464.   This compatibility was removed in Tor 0.1.2.16 and 0.2.0.4-alpha.
  1465.  
  1466. 5.4. Options for use by controllers
  1467.  
  1468.   Tor provides a few special configuration options for use by controllers.
  1469.   These options can be set and examined by the SETCONF and GETCONF commands,
  1470.   but are not saved to disk by SAVECONF.
  1471.  
  1472.   Generally, these options make Tor unusable by disabling a portion of Tor's
  1473.   normal operations.  Unless a controller provides replacement functionality
  1474.   to fill this gap, Tor will not correctly handle user requests.
  1475.  
  1476.   __AllDirOptionsPrivate
  1477.  
  1478.     If true, Tor will try to launch all directory operations through
  1479.     anonymous connections.  (Ordinarily, Tor only tries to anonymize
  1480.     requests related to hidden services.)  This option will slow down
  1481.     directory access, and may stop Tor from working entirely if it does not
  1482.     yet have enough directory information to build circuits.
  1483.  
  1484.     (Boolean. Default: "0".)
  1485.  
  1486.   __DisablePredictedCircuits
  1487.  
  1488.     If true, Tor will not launch preemptive "general purpose" circuits for
  1489.     streams to attach to.  (It will still launch circuits for testing and
  1490.     for hidden services.)
  1491.  
  1492.     (Boolean. Default: "0".)
  1493.  
  1494.   __LeaveStreamsUnattached
  1495.  
  1496.     If true, Tor will not automatically attach new streams to circuits;
  1497.     instead, the controller must attach them with ATTACHSTREAM.  If the
  1498.     controller does not attach the streams, their data will never be routed.
  1499.  
  1500.     (Boolean. Default: "0".)
  1501.  
  1502.